API

Human resource APIs

POST human-resources/employees/{employeeId}/bookmarks

Create a new bookmark. You have to specify a ParentBookmarkId. If you want to create a bookmark at the root level you can set ParentBookmarkId to -1

HTTP method POST
URI https://api.rambase.net/human-resources/employees/{employeeId}/bookmarks
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {employeeId} Employee identifier
Integer
Successful HTTP status code 201
API resource identifier 1798, version 4

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Bookmark>
2
     <Title
Title

Required/mandatory field

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

>{String}</Title>
3
     <Url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

This field is optional.

>{String}</Url>
4
     <IconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

This field is optional.

>{String}</IconName>
5
     <OrderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

This field is optional.

>{Integer}</OrderIndex>
6
     <ParentBookmark
ParentBookmark

This field is optional.

>
7
          <ParentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

This field is optional.

>{Integer}</ParentBookmarkId>
8
     </ParentBookmark>
9
</Bookmark>
1
{
2
     "bookmark": {
3
          "title
Title

Required/mandatory field

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

": "{String}",
4
          "url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

This field is optional.

": "{String}",
5
          "iconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

This field is optional.

": "{String}",
6
          "orderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

This field is optional.

": "{Integer}",
7
          "parentBookmark
ParentBookmark

This field is optional.

": {
8
               "parentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Bookmark>
2
     <BookmarkId
BookmarkId

A unique identifier for a RamBase Bookmark Item

>{String}</BookmarkId>
3
</Bookmark>
1
{
2
     "bookmark": {
3
          "bookmarkId
BookmarkId

A unique identifier for a RamBase Bookmark Item

": "{String}"
4
     }
5
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found